logo头像
Snippet 博客主题

HandyJSON的使用

简介

在OC中,我们有很多优秀的第三方库帮助我们实现,比如MJExtension、JSONModel等,这些库基本都是利用runtime实现读取属性名并利用kvc重新赋值属性
在Swift中,由于runtime的局限,比较出名的有SwiftyJSON、ObjectMapper等。
其中:
1、SwiftyJSON本质上仍然是根据JSON结构去取值,使用起来顺手、清晰;但这种做法没能妥善解决上述的几个问题,因为它不是机遇model的,我们使用的时候,依然必须制定key去获取value,这在一定程度上不是很友好。

2、ObjectMapper实现了JSON直接转Model的功能,不过使用起来,代码量会多一点,因为我们必须遵循Mappable协议,制定json内的每一个key和model属性的对应关系。

使用

1.HandyJSON支持 JSON直接转Model,定义class时,有两点注意:

必须遵循HandyJSON协议

需要实现空的initializer (当然Struct结构体 可以不需要init(),下文有说明)

1
2
3
4
5
6
7
8
9
10
11
12
class BasicTypes: HandyJSON {
var int: Int = 2
var doubleOptional: Double?
var stringImplicitlyUnwrapped: String!

required init() {}
}

let jsonString = "{\"doubleOptional\":1.1,\"stringImplicitlyUnwrapped\":\"hello\",\"int\":1}"
if let object = BasicTypes.deserialize(from: jsonString) {
// …
}

这是最简单的模型,只有三个属性,对于复杂的嵌套结构,一样这样处理实现,参考下文

2.HandyJSON还支持Struct,使用方式与Class基本一致

1
2
3
4
5
6
7
8
9
10
struct BasicTypes: HandyJSON {
var int: Int = 2
var doubleOptional: Double?
var stringImplicitlyUnwrapped: String!
}

let jsonString = "{\"doubleOptional\":1.1,\"stringImplicitlyUnwrapped\":\"hello\",\"int\":1}"
if let object = BasicTypes.deserialize(from: jsonString) {
// …
}

这里注意一下,虽然Struct自己已经帮助构造了init初始化,但如果我们需要重载init,构造我们自己的初始化,还是需要写一下的。

3.HandyJSON支持枚举,只需要enum构造时服从HandyJSONEnum协议即可。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
enum AnimalType: String, HandyJSONEnum {
case Cat = "cat"
case Dog = "dog"
case Bird = "bird"
}

struct Animal: HandyJSON {
var name: String?
var type: AnimalType?
}

let jsonString = "{\"type\":\"cat\",\"name\":\"Tom\"}"
if let animal = Animal.deserialize(from: jsonString) {
print(animal.type?.rawValue)
}

4、此外,HandyJSON还支持一些非基础类型、复杂类型,包括嵌套结构,如可选、隐式解包可选、集合等

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class BasicTypes: HandyJSON {
var bool: Bool = true
var intOptional: Int?
var doubleImplicitlyUnwrapped: Double!
var anyObjectOptional: Any?

var arrayInt: Array<Int> = []
var arrayStringOptional: Array<String>?
var setInt: Set<Int>?
var dictAnyObject: Dictionary<String, Any> = [:]

var nsNumber = 2
var nsString: NSString?

required init() {}
}

let object = BasicTypes()
object.intOptional = 1
object.doubleImplicitlyUnwrapped = 1.1
object.anyObjectOptional = "StringValue"
object.arrayInt = [1, 2]
object.arrayStringOptional = ["a", "b"]
object.setInt = [1, 2]
object.dictAnyObject = ["key1": 1, "key2": "stringValue"]
object.nsNumber = 2
object.nsString = "nsStringValue"

let jsonString = object.toJSONString()!

if let object = JSONDeserializer<BasicTypes>.deserializeFrom(json: jsonString) {
// ...
}

5、HandyJSON支持指定从哪个具体路径开始解析,反序列化到Model。

这个比较常用,因为正常情况下,接口一般都会返回包括错误码,错误消息,正式请求数据等,但我们一般只需要把正式数据转换成Model即可。

1
2
3
4
5
6
7
8
9
10
11
12
class Cat: HandyJSON {
var id: Int64!
var name: String!

required init() {}
}

let jsonString = "{\"code\":200,\"msg\":\"success\",\"data\":{\"cat\":{\"id\":12345,\"name\":\"Kitty\"}}}"

if let cat = JSONDeserializer<Cat>.deserializeFrom(json: jsonString, designatedPath: "data.cat") {
print(cat.name)
}

其中,直接通过 designatedPath 定位到我们需要的节点处。

6、handyJSON支持有继承关系的Model类,就是说及时某个类没有实现HandyJSON协议,只要父类有实现,依然可以转化model。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
class Animal: HandyJSON {
var id: Int?
var color: String?

required init() {}
}


class Cat: Animal {
var name: String?

required init() {}
}

let jsonString = "{\"id\":12345,\"color\":\"black\",\"name\":\"cat\"}"

if let cat = JSONDeserializer<Cat>.deserializeFrom(json: jsonString) {
print(cat)
}

7、上面都是基本在说JSON转模型,那么反过来实现呢?HandyJSON还支持对象转字典、对象转模型。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
class BasicTypes: HandyJSON {
var int: Int = 2
var doubleOptional: Double?
var stringImplicitlyUnwrapped: String!

required init() {}
}

let object = BasicTypes()
object.int = 1
object.doubleOptional = 1.1
object.stringImplicitlyUnwrapped = “hello"

print(object.toJSON()!) // 序列化到字典
print(object.toJSONString()!) // 序列化到JSON字符串
print(object.toJSONString(prettyPrint: true)!) // 序列化为格式化后的JSON字符串
微信打赏

赞赏是不耍流氓的鼓励